<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\library\Response</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: "><span class="description">__construct()
        </span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#addHeader" title="addHeader :: Adds arbitrary headers to the response"><span class="description">Adds arbitrary headers to the response</span><pre>addHeader()</pre></a></li>
<li class="method public "><a href="#compress" title="compress :: Determines browser capability for compression and applies compression
and returns compressed data if possible."><span class="description">Determines browser capability for compression and applies compression
and returns compressed data if possible.</span><pre>compress()</pre></a></li>
<li class="method public "><a href="#getCompression" title="getCompression :: "><span class="description">getCompression()
        </span><pre>getCompression()</pre></a></li>
<li class="method public "><a href="#getHeaders" title="getHeaders :: "><span class="description">getHeaders()
        </span><pre>getHeaders()</pre></a></li>
<li class="method public "><a href="#noCache" title="noCache :: Prevents caching by the browser"><span class="description">Prevents caching by the browser</span><pre>noCache()</pre></a></li>
<li class="method public "><a href="#output" title="output :: Sends the very final response (possible in compressed form)"><span class="description">Sends the very final response (possible in compressed form)</span><pre>output()</pre></a></li>
<li class="method public "><a href="#redirect" title="redirect :: Sends a redirect header that immediately redirects the client"><span class="description">Sends a redirect header that immediately redirects the client</span><pre>redirect()</pre></a></li>
<li class="method public "><a href="#setCompression" title="setCompression :: Sets the gzip compression level (0[none] to 9[max])"><span class="description">Sets the gzip compression level (0[none] to 9[max])</span><pre>setCompression()</pre></a></li>
<li class="method public "><a href="#setCookie" title="setCookie :: Sets a cookie to be sent with other headers"><span class="description">Sets a cookie to be sent with other headers</span><pre>setCookie()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24headers" title="$headers :: "><span class="description">$headers</span><pre>$headers</pre></a></li>
<li class="property private "><a href="#%24level" title="$level :: "><span class="description">$level</span><pre>$level</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5Clibrary%5CResponse" id="\framework\library\Response"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.html">library</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.library.Response.html">Response</a>
</li>
</ul>
<div href="../classes/framework.library.Response.html" class="element class">
<p class="short_description">Response Class</p>
<div class="details">
<p class="long_description"><p>Plurious Core</p>

<p>Provides convenience methods for normal HTTP responses</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\framework/Front</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\Document</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>__construct()
        </h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="addHeader" id="addHeader"></a><div class="element clickable method public addHeader" data-toggle="collapse" data-target=".addHeader .collapse">
<h2>Adds arbitrary headers to the response</h2>
<pre>addHeader(string $header) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Must be full string headers ready for output</p></p>
<table class="table table-bordered"><tr>
<th>see</th>
<td>\framework\library\$this-&gt;redirect()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$header</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="compress" id="compress"></a><div class="element clickable method public compress" data-toggle="collapse" data-target=".compress .collapse">
<h2>Determines browser capability for compression and applies compression
and returns compressed data if possible.</h2>
<pre>compress(string $data, int $level) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Otherwise returns uncompressed data.</p></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\library\Registry</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Request</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$data</h4>
<code>string</code><p>Data to be compressed</p></div>
<div class="subelement argument">
<h4>$level</h4>
<code>int</code><p>The g-zip compression level 0[none] to 9[max]</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The compressed or uncompressed output string</div>
</div></div>
</div>
<a name="getCompression" id="getCompression"></a><div class="element clickable method public getCompression" data-toggle="collapse" data-target=".getCompression .collapse">
<h2>getCompression()
        </h2>
<pre>getCompression() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="getHeaders" id="getHeaders"></a><div class="element clickable method public getHeaders" data-toggle="collapse" data-target=".getHeaders .collapse">
<h2>getHeaders()
        </h2>
<pre>getHeaders() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="noCache" id="noCache"></a><div class="element clickable method public noCache" data-toggle="collapse" data-target=".noCache .collapse">
<h2>Prevents caching by the browser</h2>
<pre>noCache() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="output" id="output"></a><div class="element clickable method public output" data-toggle="collapse" data-target=".output .collapse">
<h2>Sends the very final response (possible in compressed form)</h2>
<pre>output(string $output, string $type) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>todo</th>
<td>finish json and feed implementations</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$output</h4>
<code>string</code><p>The Page content</p></div>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code><p>One of document, json, atom, rss2.0</p></div>
</div></div>
</div>
<a name="redirect" id="redirect"></a><div class="element clickable method public redirect" data-toggle="collapse" data-target=".redirect .collapse">
<h2>Sends a redirect header that immediately redirects the client</h2>
<pre>redirect(string $url, int $status) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Exits script execution</p>

<p>NOTE: This has been unit tested, but the exit statement prevents PHPUnit
from continuing.  There are two options for testing this method:
1. comment out the exit() statement and test code in ResponseTest.php
2. Add Sebastian's PHPUnit test-helper to your php configuration</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$url</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$status</h4>
<code>int</code>
</div>
</div></div>
</div>
<a name="setCompression" id="setCompression"></a><div class="element clickable method public setCompression" data-toggle="collapse" data-target=".setCompression .collapse">
<h2>Sets the gzip compression level (0[none] to 9[max])</h2>
<pre>setCompression(int $level) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$level</h4>
<code>int</code>
</div>
</div></div>
</div>
<a name="setCookie" id="setCookie"></a><div class="element clickable method public setCookie" data-toggle="collapse" data-target=".setCookie .collapse">
<h2>Sets a cookie to be sent with other headers</h2>
<pre>setCookie($cookie) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$cookie</h4>
<code></code>
</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24headers" id="$headers"> </a><div class="element clickable property private $headers" data-toggle="collapse" data-target=".$headers .collapse">
<h2>$headers</h2>
<pre>$headers </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24level" id="$level"> </a><div class="element clickable property private $level" data-toggle="collapse" data-target=".$level .collapse">
<h2>$level</h2>
<pre>$level </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:44-05:00.<br></footer></div>
</div>
</body>
</html>
